home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
Cream of the Crop 20
/
Cream of the Crop 20 (Terry Blount) (1996).iso
/
bbs
/
g5108b.zip
/
G5.ZIP
/
TEXT
/
XPORTS.TXT
< prev
Wrap
Text File
|
1996-06-17
|
17KB
|
285 lines
──══ Galaxy 5 ══──
Copyright (c) 1996 Thomas J. Smith
────────────────────────────────────────────────────────────────────
This text file explains the use of Xports, how to install and use
them, and how to go about creating your own!
────────────────────────────────────────────────────────────────────
For a complete listing of data file structures, formats of all of
the drop files that G5 creates, and a complete list of color, and
other codes, unzip the G5_STRUC.ZIP archive. Everything 3rd party
programmers need is located in this archive!
────────────────────────────────────────────────────────────────────
HOW THEY WORK
────────────────────────────────────────────────────────────────────
In order to explain this in the simplest way, I will use an
example. Lets say Joe SysOp just downloaded an Xport called
"Hermans World." First, Joe unzips the file he just downloaded to
a temporary directory (or the directory he wishes the Xport to be
installed to). Then Joe will read the docs that came with the .ZIP
file first (or will he?). In the docs, Joe will find that all he
needs to do to install this Xport, is run the INSTALL.EXE program
included with the .ZIP file (or other installation method). The
install program then puts all the necessarry files in their proper
places, and writes the needed info to the XPORTS.DAT file in Joes
main Galaxy 5 directory.
────────────────────────────────────────────────────────────────────
Now to use the Xport, Joe logs on to Galaxy 5 either locally, or
by logging on to his BBS locally, and running the game from there.
From the main menu (Lexor Street, or whichever planet he is on),
Joe will choose the option, "(X)port to another place." Then he is
taken to a menu listing all of the Xports he has installed. If he
only installed one Xport, then only the name of that one Xport
will be listed as number (1). Joe then presses 1 to go to this
Xport, and wala! Thats all there is to it. After Joe is done using
the Xport, Galaxy 5 reloads, and picks up from the Xport menu
where it left off, and deducts the time that Joe was in the Xport
from his time left in the game!
────────────────────────────────────────────────────────────────────
Then later (or right after trying it), if Joe finds that he does
not like this Xport, he runs the UNINSTAL.EXE program that came
with the Xport (or whatever program the Xports docs point him
to), and the game is "uninstalled!"
────────────────────────────────────────────────────────────────────
Q & A
────────────────────────────────────────────────────────────────────
Q. What is an Xport?
----------------------
A. An Xport is an external program (door) created by third
party programmers for use in your Galaxy 5 game. They can
be run directly from within the game, without any special
setup on the SysOps part!
────────────────────────────────────────────────────────────────────
Q. Where can I find an Xport?
-------------------------------
A. Good question! Depending on how well Galaxy 5 does with
popularity, it may or may not be hard to find an Xport.
However, I have created a freeware Xport named "The Inscribers
Guild." It allows players to personalize their Armour, Weapon,
and Space Craft at a price the SysOp sets. SysOp can also
disallow personalizing of any of the three items mentioned.
Look for SCRIBE??.ZIP (where ?? is the version number).
────────────────────────────────────────────────────────────────────
Q. If I find one, how do I set it up?
---------------------------------------
A. It should be extremely simple to set up. As a ground rule,
any Xport created by a third party programmer, must come
with an easy to use install program, and easy to use
"uninstall" program in case the SysOp does not like it, or
needs to remove it for some reason. The SysOp installing the
Xport, should not have to do anything else but run the
INSTALL program that comes with the Xport!
────────────────────────────────────────────────────────────────────
Q. What if an Xport I installed doesn't work properly?
--------------------------------------------------------
A. Read the docs that came with it. If the author(s) of the Xport
provides support for the program, then follow their
instructions on how to obtain that support. It is beyond my
ability to help with problems concerning someone elses
program! :) If all else fails, remove the Xport from your
game. If the Xport just happened not to come with an
uninstall program, then remove the two lines in the
XPORTS.DAT file that pertain to that Xport.
────────────────────────────────────────────────────────────────────
Q. I write doors, how can I make an Xport?
--------------------------------------------
A. If the door writing kit that you use supports the Quick BBS
drop file format (DORINFO*.DEF where * is the node number),
then you may already have what you need to write your own
Xport! Galaxy 5 creates 3 drop files before running an Xport,
one of which is a DORINFO*.DEF compatible drop file. Figure
out some way to have your Xport read this drop file (located
in the TEMP subdirectory), and it -should- be all you need!
Other door writing kits that are directly supported are UrDoor,
and the DDplus door driver kit. Read the next section,
"Creating Your Own Xports." It explains everything you need to
know!
────────────────────────────────────────────────────────────────────
CREATING YOUR OWN XPORTS
────────────────────────────────────────────────────────────────────
** Unzip the G5_STRUC.ZIP archive!! It contains everything you
need to know!!! ;>
────────────────────────────────────────────────────────────────────
If you do not program in Turbo Pascal, and would still like to
make an Xport for Galaxy 5, then refer to the G5_STRUC.ZIP
archive. Galaxy 5 creates a plain text drop file containing the
callers full record information, in which you can make changes to,
and Galaxy 5 will accept the changes upon returning from your
Xport.
────────────────────────────────────────────────────────────────────
Before your creation(s) can be "officially" called Xports, you
must follow these 3 simple rules:
────────────────────────────────────────────────────────────────────
1 ■ It must come with an easy to use install program, and an easy
to use uninstall program. These can be implemented as separate
.EXE's, or as command line switches in your game, or whatever.
What the install program must do, is place its game files in
the proper directory (preferably its own directory off of the
main Galaxy 5 directory), and write its needed two lines to
the XPORTS.DAT file located in the main Galaxy 5 directory.
The XPORTS.DAT file, is a regular text file, listing the name
of your Xport as it will be shown to callers first, and then
the command line you want passed to your door when a player
uses the Xport on the second line. Here is an example,
~0B~T~01~he ~0B~I~01~nscribers ~0B~G~01~uild
C:\DOORS\GALAXY5\SCRIBES\SCRIBES.EXE ~UN~
In the above example, the characters in between the tilde (~)
signs are codes use